home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
SGI Freeware 1999 August
/
SGI Freeware 1999 August.iso
/
dist
/
fw_xemacs.idb
/
usr
/
freeware
/
lib
/
xemacs-20.4
/
info
/
pcl-cvs.info.z
/
pcl-cvs.info
Encoding:
Amiga
Atari
Commodore
DOS
FM Towns/JPY
Macintosh
Macintosh JP
Macintosh to JP
NeXTSTEP
RISC OS/Acorn
Shift JIS
UTF-8
Wrap
GNU Info File
|
1998-05-21
|
57.7 KB
|
1,407 lines
This is Info file ../info/pcl-cvs.info, produced by Makeinfo version
1.68 from the input file pcl-cvs.texi.
Copyright (C) 1992 Per Cederqvist
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided also
that the section entitled "GNU General Public License" is included
exactly as in the original, and provided that the entire resulting
derived work is distributed under the terms of a permission notice
identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for modified
versions, except that the section entitled "GNU General Public License"
and this permission notice may be included in translations approved by
the Free Software Foundation instead of in the original English.
File: pcl-cvs.info, Node: Top, Next: Installation, Prev: (dir), Up: (dir)
This info manual describes pcl-cvs which is a GNU Emacs front-end to
CVS. It works with CVS versions 1.5 through 1.7 and newer, and possibly
CVS-1.3 and CVS-1.4A2. This manual is updated to release 1.05-CVS-1.7
of pcl-cvs.
* Menu:
* Installation:: How to install pcl-cvs on your system.
* About pcl-cvs:: Authors and ftp sites.
* Getting started:: An introduction with a walk-through example.
* Buffer contents:: An explanation of the buffer contents.
* Commands:: All commands, grouped by type.
* Customization:: How you can tailor pcl-cvs to suit your needs.
* Future enhancements:: Future enhancements of pcl-cvs.
* Bugs:: Bugs (known and unknown).
* COPYING:: GNU General Public License
* Function and Variable Index:: List of functions and variables.
* Concept Index:: List of concepts.
* Key Index:: List of keystrokes.
-- The Detailed Node Listing --
Installation
* Pcl-cvs installation:: How to install pcl-cvs on your system.
* On-line manual installation:: How to install the on-line manual.
* Typeset manual installation:: How to create typeset documentation
about pcl-cvs.
About pcl-cvs
* Contributors:: Contributors to pcl-cvs.
* Archives:: Where can I get a copy of Pcl-Cvs?
Buffer contents
* File status:: The meaning of the second field.
* Selected files:: How selection works.
Commands
* Updating the directory:: Commands to update the local directory
* Movement commands:: How to move up and down in the buffer
* Marking files:: How to mark files that other commands
will later operate on.
* Committing changes:: Checking in your modifications to the
CVS repository.
* Editing files:: Loading files into Emacs.
* Getting info about files:: Display the log and status of files.
* Adding and removing files:: Adding and removing files
* Undoing changes:: Undoing changes
* Removing handled entries:: Uninteresting lines can easily be removed.
* Ignoring files:: Telling CVS to ignore generated files.
* Viewing differences:: Commands to `diff' different versions.
* Invoking Ediff:: Running `ediff' from `*cvs*' buffer.
* Invoking Emerge:: Running `emerge' from `*cvs*' buffer.
* Reverting your buffers:: Reverting your buffers
* Miscellaneous commands:: Miscellaneous commands
File: pcl-cvs.info, Node: Installation, Next: About pcl-cvs, Prev: Top, Up: Top
Installation
************
This section describes the installation of pcl-cvs, the GNU Emacs CVS
front-end. You should install not only the elisp files themselves, but
also the on-line documentation so that your users will know how to use
it. You can create typeset documentation from the file
`pcl-cvs.texinfo' as well as an on-line info file. The following steps
are also described in the file `INSTALL' in the source directory.
* Menu:
* Pcl-cvs installation:: How to install pcl-cvs on your system.
* On-line manual installation:: How to install the on-line manual.
* Typeset manual installation:: How to create typeset documentation
about pcl-cvs.
File: pcl-cvs.info, Node: Pcl-cvs installation, Next: On-line manual installation, Prev: Installation, Up: Installation
Installation of the pcl-cvs program
===================================
1. Possibly edit the file `Makefile' to reflect the situation at your
site. We say "possibly" because the version of pcl-cvs included
with CVS uses a configuration mechanism integrated with the overall
mechanisms used by the CVS build and install procedures. Thus the
file `Makefile' will be generated automatically from the file
`Makefile.in', and it should not be necessary to edit it further.
If you do have to edit the `Makefile', the only things you have to
change is the definition of `lispdir' and `infodir'. The elisp
files will be copied to `lispdir', and the info file(s) to
`infodir'.
2. Configure pcl-cvs.el
There are a couple of pathnames that you have to check to make
sure that they match your system. They appear early in the file
`pcl-cvs.el'.
*NOTE:* If your system is running emacs 18.57 or earlier you MUST
uncomment the line that says:
(setq delete-exited-processes nil)
Setting `delete-exited-processes' to `nil' works around a bug in
emacs that causes it to dump core. The bug was fixed in emacs
18.58.
3. Release 1.05 and later of pcl-cvs requires parts of the Elib
library, version 1.0 or later. Elib is available via anonymous
ftp from prep.ai.mit.edu in `pub/gnu/elib-1.0.tar.gz', and from a
lot of other sites that mirror prep. Get Elib, and install it,
before proceeding.
*NOTE:* The version of pcl-cvs included with CVS includes a copy
of Elib in the sub-directory `elib' under the `contrib/pcl-cvs'
directory.
4. Type `make install' in the source directory. This will
byte-compile all `.el' files and copy the `*.elc' files into the
directory you specified in step 1.
If you want to install the `*.el' files too, you can type `make
install-el' to do so.
If you only want to create the compiled elisp files, but don't
want to install them, you can type `make' without parameters.
5. Edit the file `default.el' in your emacs lisp directory (usually
`/usr/gnu/lib/emacs/site-lisp' or something similar) and enter the
contents of the file `pcl-cvs-startup.el' into it. It contains a
couple of `auto-load's that facilitates the use of pcl-cvs.
File: pcl-cvs.info, Node: On-line manual installation, Next: Typeset manual installation, Prev: Pcl-cvs installation, Up: Installation
Installation of the on-line manual.
===================================
1. Create the info file(s) `pcl-cvs.info*' from `pcl-cvs.texinfo' by
typing `make info'. If you don't have the program `makeinfo' you
can get it by anonymous ftp from e.g. `prep.ai.mit.edu' as
`pub/gnu/texinfo-3.7.tar.gz' (there might be a newer version there
when you read this).
2. Install the info file(s) `pcl-cvs.info*' into your standard `info'
directory. You should be able to do this by typing `make
install-info'.
3. Edit the file `dir' in the `info' directory and enter one line to
contain a pointer to the info file(s) `pcl-cvs.info*'. The line
can, for instance, look like this:
* Pcl-cvs: (pcl-cvs). An Emacs front-end to CVS.
File: pcl-cvs.info, Node: Typeset manual installation, Prev: On-line manual installation, Up: Installation
How to make typeset documentation from pcl-cvs.texinfo
======================================================
If you have TeX installed at your site, you can make a typeset manual
from `pcl-cvs.texinfo'.
1. Run TeX by typing ``make pcl-cvs.dvi''. You will not get the
indices unless you have the `texindex' program.
2. Convert the resulting device independent file `pcl-cvs.dvi' to a
form which your printer can output and print it. If you have a
postscript printer there is a program, `dvi2ps', which does. There
is also a program which comes together with TeX, `dvips', which
you can use.
File: pcl-cvs.info, Node: About pcl-cvs, Next: Getting started, Prev: Installation, Up: Top
About pcl-cvs
*************
Pcl-cvs is a front-end to CVS versions 1.5 through 1.7 and newer; and
possibly verison 1.3 and 1.4A2. It integrates the most frequently used
CVS commands into an emacs interface.
* Menu:
* Contributors:: Contributors to pcl-cvs.
* Archives:: Where can I get a copy of Pcl-Cvs?
File: pcl-cvs.info, Node: Contributors, Next: Archives, Prev: About pcl-cvs, Up: About pcl-cvs
Contributors to pcl-cvs
=======================
Contributions to the package are welcome. I have limited time to
work on this project, but I will gladly add any code that you
contribute to me to this package (*note Bugs::.).
The following persons have made contributions to pcl-cvs.
* Brian Berliner wrote CVS, together with some other contributors.
Without his work on CVS this package would be useless...
* Per Cederqvist wrote most of the otherwise unattributed functions
in pcl-cvs as well as all documentation.
* Inge Wallin (`inge@lysator.liu.se') wrote the skeleton to
`pcl-cvs.texinfo', and gave useful comments on it. He also wrote
the files `elib-node.el' and `compile-all.el'. The file
`cookie.el' was inspired by Inge.
* Linus Tolke (`linus@lysator.liu.se') contributed useful comments
on both the functionality and the documentation.
* Jamie Zawinski (`jwz@lucid.com') contributed `pcl-cvs-lucid.el'.
* Leif Lonnblad contributed RCVS support. (Since superceded by the
new remote CVS support.)
* Jim Blandy (`jimb@cyclic.com') contributed hooks to automatically
guess CVS log entries from ChangeLog contents; and initial support
of the new Cygnus / Cyclic remote CVS; as well as various sundry
bug fixes and cleanups.
* Jim Kingdon (`kingdon@cyclic.com') contributed lots of fixes to
the build and install procedure.
* Greg A. Woods (`woods@planix.com') contributed code to implement
the use of per-file diff buffers; and vendor join diffs with
emerge and ediff; as well as various an sundry bug fixes and
cleanups.
Apart from these, a lot of people have send me suggestions, ideas,
requests, bug reports and encouragement. Thanks a lot! Without your
there would be no new releases of pcl-cvs.
File: pcl-cvs.info, Node: Archives, Prev: Contributors, Up: About pcl-cvs
Where can I get pcl-cvs?
========================
The current release of pcl-cvs is included in CVS-1.7.
The author's release of pcl-cvs can be fetched via anonymous ftp from
`ftp.lysator.liu.se', (IP no. 130.236.254.1) in the directory
`pub/emacs'. If you don't live in Scandinavia you should probably
check with archie to see if there is a site closer to you that archives
pcl-cvs.
New releases will be announced to appropriate newsgroups. If you
send your email address to me I will add you to my list of people to
mail when I make a new release.
File: pcl-cvs.info, Node: Getting started, Next: Buffer contents, Prev: About pcl-cvs, Up: Top
Getting started
***************
This document assumes that you know what CVS is, and that you at
least knows the fundamental concepts of CVS. If that is not the case
you should read the man page for CVS.
Pcl-cvs is only useful once you have checked out a module. So before
you invoke it you must have a copy of a module somewhere in the file
system.
You invoke pcl-cvs by typing `M-x cvs-update RET'. If your emacs
responds with `[No match]' your system administrator has not installed
pcl-cvs properly. Try `M-x load-library RET pcl-cvs RET'. If that
also fails - talk to your root. If it succeeds you might put this line
in your `.emacs' file so that you don't have to type the `load-library'
command every time you wish to use pcl-cvs:
(autoload 'cvs-update "pcl-cvs" nil t)
The function `cvs-update' will ask for a directory. The command
`cvs update' will be run in that directory. (It should contain files
that have been checked out from a CVS archive.) The output from `cvs'
will be parsed and presented in a table in a buffer called `*cvs*'. It
might look something like this:
PCL-CVS release 1.05-CVS-1.7.
In directory /users/ceder/FOO/test:
Updated bar
Updated file.txt
Modified ci namechange
Updated newer
In directory /users/ceder/FOO/test/sub:
Modified ci ChangeLog
---------- End -----
In this example the two files (`bar', `file.txt', and `newer') that
are marked with `Updated' have been copied from the CVS repository to
`/users/ceder/FOO/test/' since someone else have checked in newer
versions of them. Two files (`namechange' and `sub/ChangeLog') have
been modified locally, and needs to be checked in.
You can move the cursor up and down in the buffer with `C-n' and
`C-p' or `n' and `p'. If you press `c' on one of the `Modified' files
that file will be checked in to the CVS repository. *Note Committing
changes::. You can press `x' to get rid of the "uninteresting" files
that have only been `Updated' (and don't require any further action
from you).
You can also easily get a `diff' between your modified file and the
base version that you started from, and you can get the output from
`cvs log' and `cvs status' on the listed files simply by pressing a key
(*note Getting info about files::.).
File: pcl-cvs.info, Node: Buffer contents, Next: Commands, Prev: Getting started, Up: Top
Buffer contents
***************
The display contains four columns. They contain, from left to right:
* An asterisk when the file is "marked" (*note Selected files::.).
* The status of the file. See *Note File status::, for more
information.
* A "need to be checked in"-marker (`ci').
* The file name.
* Menu:
* File status:: The meaning of the second field.
* Selected files:: How selection works.
File: pcl-cvs.info, Node: File status, Next: Selected files, Prev: Buffer contents, Up: Buffer contents
File status
===========
The `file status' field can have the following values:
`Updated'
The file was brought up to date with respect to the repository.
This is done for any file that exists in the repository but not in
your source, and for files that you haven't changed but are not
the most recent versions available in the repository.
`Patched'
The file was brought up to date with respect to a remote
repository by way of fetching and applying a patch to the file in
your source. This is done for any file that exists in a remote
repository and in your source; of which you haven't changed
locally but is not the most recent version available in the remote
repository.
`Modified'
The file is modified in your working directory, and there was no
modification to the same file in the repository.
`Merged'
The file is modified in your working directory, and there were
modifications in the repository as well as in your copy, but they
were merged successfully, without conflict, in your working
directory.
`Conflict'
A conflict was detected while trying to merge your changes to FILE
with changes from the source repository. FILE (the copy in your
working directory) is now the output of the `rcsmerge' command on
the two versions; an unmodified copy of your file is also in your
working directory, with the name `.#FILE.VERSION', where VERSION
is the RCS revision that your modified file started from. *Note
Viewing differences::, for more details.
`Added'
The file has been added by you, but it still needs to be checked
in to the repository.
`Removed'
The file has been removed by you, but it needs to be checked in to
the repository. You can resurrect it by typing `a' (*note Adding
and removing files::.).
`Unknown'
A file that was detected in your directory, but that neither
appears in the repository, nor is present on the list of files
that CVS should ignore.
There are also a few special cases, that rarely occur, which have
longer strings in the fields:
`Removed from repository'
The file has been removed from your directory since someone has
removed it from the repository. (It is still present in the Attic
directory, so no permanent loss has occurred). This, unlike the
other entries in this table, is not an error condition.
`Removed from repository, changed by you'
You have modified a file that someone have removed from the
repository. You can correct this situation by removing the file
manually (see *note Adding and removing files::.).
`Removed by you, changed in repository'
You have removed a file, and before you committed the removal
someone committed a change to that file. You could use `a' to
resurrect the file (see *note Adding and removing files::.).
`Move away FILE - it is in the way'
For some reason CVS does not like the file FILE. Rename or remove
it.
`This repository is missing! Remove this dir manually.'
It is impossible to remove a directory in the CVS repository in a
clean way. Someone have tried to remove one, and CVS gets
confused. Remove your copy of the directory.
File: pcl-cvs.info, Node: Selected files, Prev: File status, Up: Buffer contents
Selected files
==============
Many of the commands works on the current set of "selected" files.
* If there are any files that are marked they constitute the set of
selected files.
* Otherwise, if the cursor points to a file, that file is the
selected file.
* Otherwise, if the cursor points to a directory, all the files in
that directory that appears in the buffer are the selected files.
This scheme might seem a little complicated, but once one get used to
it, it is quite powerful.
*Note Marking files:: tells how you mark and unmark files.
File: pcl-cvs.info, Node: Commands, Next: Customization, Prev: Buffer contents, Up: Top
Commands
********
The nodes in this menu contains explanations about all the commands
that you can use in pcl-cvs. They are grouped together by type.
* Menu:
* Updating the directory:: Commands to update the local directory
* Movement commands:: How to move up and down in the buffer
* Marking files:: How to mark files that other commands
will later operate on.
* Committing changes:: Checking in your modifications to the
CVS repository.
* Editing files:: Loading files into Emacs.
* Getting info about files:: Display the log and status of files.
* Adding and removing files:: Adding and removing files
* Undoing changes:: Undoing changes
* Removing handled entries:: Uninteresting lines can easily be removed.
* Ignoring files:: Telling CVS to ignore generated files.
* Viewing differences:: Commands to `diff' different versions.
* Invoking Ediff:: Running `ediff' from `*cvs*' buffer.
* Invoking Emerge:: Running `emerge' from `*cvs*' buffer.
* Reverting your buffers:: Reverting your buffers
* Miscellaneous commands:: Miscellaneous commands
File: pcl-cvs.info, Node: Updating the directory, Next: Movement commands, Prev: Commands, Up: Commands
Updating the directory
======================
`M-x cvs-update'
Run a `cvs update' command. You will be asked for the directory in
which the `cvs update' will be run. The output will be parsed by
pcl-cvs, and the result printed in the `*cvs*' buffer (see *note
Buffer contents::. for a description of the contents).
By default, `cvs-update' will descend recursively into
subdirectories. You can avoid that behavior by giving a prefix
argument to it (e.g., by typing `C-u M-x cvs-update RET').
All other commands in pcl-cvs requires that you have a `*cvs*'
buffer. This is the command that you use to get one.
CVS uses lock files in the repository to ensure the integrity of
the data files in the repository. They might be left behind i.e.
if a workstation crashes in the middle of a CVS operation. CVS
outputs a message when it is waiting for a lock file to go away.
Pcl-cvs will show the same message in the *cvs* buffer, together
with instructions for deleting the lock files. You should
normally not have to delete them manually -- just wait a little
while and the problem should fix itself. But if the lock files
doesn't disappear you can delete them with `M-x cvs-delete-lock
RET'.
`g'
This will run `cvs update' again. It will always use the same
buffer that was used with the previous `cvs update'. Give a prefix
argument to avoid descending into subdirectories. This runs the
command `cvs-mode-update-no-prompt'.
`G'
This will run `cvs update' and prompt for a new directory to
update. This runs the command `cvs-update'.
File: pcl-cvs.info, Node: Movement commands, Next: Marking files, Prev: Updating the directory, Up: Commands
Movement Commands
=================
You can use most normal Emacs commands to move forward and backward
in the buffer. Some keys are rebound to functions that take advantage
of the fact that the buffer is a pcl-cvs buffer:
`SPC'
`C-n'
`n'
These keys move the cursor one file forward, towards the end of the
buffer (`cookie-next-cookie').
`C-p'
`p'
These keys move one file backward, towards the beginning of the
buffer (`cookie-previous-cookie').
File: pcl-cvs.info, Node: Marking files, Next: Committing changes, Prev: Movement commands, Up: Commands
Marking files
=============
Pcl-cvs works on a set of "selected files" (*note Selected files::.).
You can mark and unmark files with these commands:
`m'
This marks the file that the cursor is positioned on. If the
cursor is positioned on a directory all files in that directory
will be marked. (`cvs-mode-mark').
`u'
Unmark the file that the cursor is positioned on. If the cursor
is on a directory, all files in that directory will be unmarked.
(`cvs-mode-unmark').
`M'
Mark *all* files in the buffer (`cvs-mode-mark-all-files').
`<ESC> <DEL>'
Unmark *all* files (`cvs-mode-unmark-all-files').
`<DEL>'
Unmark the file on the previous line, and move point to that line
(`cvs-mode-unmark-up').
File: pcl-cvs.info, Node: Committing changes, Next: Editing files, Prev: Marking files, Up: Commands
Committing changes
==================
`c'
All files that have a "need to be checked in"-marker (*note Buffer
contents::.) can be checked in with the `c' command. It checks in
all selected files (*note Selected files::.) (except those who
lack the "ci"-marker - they are ignored). Pressing `c' causes
`cvs-mode-commit' to be run.
When you press `c' you will get a buffer called
`*cvs-commit-message*'. Enter the log message for the file(s) in
it. When you are ready you should press `C-c C-c' to actually
commit the files (using `cvs-edit-done').
Normally the `*cvs-commit-message*' buffer will retain the log
message from the previous commit, but if the variable
`cvs-erase-input-buffer' is set to a non-`nil' value the buffer
will be erased. Point and mark will always be located around the
entire buffer so that you can easily erase it with `C-w'
(`kill-region').
If you are editing the files in your emacs an automatic
`revert-buffer' will be performed. (If the file contains `$Id$'
keywords `cvs commit' will write a new file with the new values
substituted. The auto-revert makes sure that you get them into
your buffer). The revert will not occur if you have modified your
buffer, or if `cvs-auto-revert-after-commit' is set to `nil'.
`C'
This is just like `cvs-mode-commit', except that it tries to
provide appropriate default log messages by looking at the
`ChangeLog's in the current directory. The idea is to write your
ChangeLog entries first, and then use this command to commit your
changes. Pressing `C' causes `cvs-mode-changelog-commit' to be
run.
To select default log text, pcl-cvs:
- finds the ChangeLogs for the files to be checked in;
- verifies that the top entry in the ChangeLog is on the
current date and by the current user; if not, no default text
is provided;
- search the ChangeLog entry for paragraphs containing the
names of the files we're checking in; and finally
- uses those paragraphs as the default log text in the
`*cvs-commit-message*' buffer.
You can then commit the `ChangeLog' file once per day without any
log message.
File: pcl-cvs.info, Node: Editing files, Next: Getting info about files, Prev: Committing changes, Up: Commands
Editing files
=============
There are currently three commands that can be used to find a file
(that is, load it into a buffer and start editing it there). These
commands work on the line that the cursor is situated at. They ignore
any marked files.
`f'
Find the file that the cursor points to. Run `dired' (*note
Dired: (Emacs)Dired.) if the cursor points to a directory
(`cvs-mode-find-file').
`o'
Like `f', but use another window
(`cvs-mode-find-file-other-window').
`A'
Invoke `add-change-log-entry-other-window' to edit a `ChangeLog'
file. The `ChangeLog' will be found in the directory of the file
the cursor points to.
(`cvs-mode-add-change-log-entry-other-window').
File: pcl-cvs.info, Node: Getting info about files, Next: Adding and removing files, Prev: Editing files, Up: Commands
Getting info about files
========================
Both of the following commands can be customized. *Note
Customization::.
`l'
Run `cvs log' on all selected files, and show the result in a
temporary buffer (`cvs-mode-log').
`s'
Run `cvs status' on all selected files, and show the result in a
temporary buffer (`cvs-mode-status').
File: pcl-cvs.info, Node: Adding and removing files, Next: Undoing changes, Prev: Getting info about files, Up: Commands
Adding and removing files
=========================
The following commands are available to make it easy to add and
remove files from the CVS repository.
`a'
Add all selected files. This command can be used on `Unknown'
files (see *note File status::.). The status of the file will
change to `Added', and you will have to use `c'
(`cvs-mode-commit', see *note Committing changes::.) to really add
the file to the repository.
This command can also be used on `Removed' files (before you commit
them) to resurrect them.
Selected files that are neither `Unknown' nor `Removed' will be
ignored by this command.
The command that is run is `cvs-mode-add'.
`r'
This command removes the selected files (after prompting for
confirmation). The files are `rm'ed from your directory and
(unless the status was `Unknown'; *note File status::.) they will
also be `cvs remove'd. If the files were `Unknown' they will
disappear from the buffer. Otherwise their status will change to
`Removed', and you must use `c' (`cvs-mode-commit', *note
Committing changes::.) to commit the removal.
The command that is run is `cvs-mode-remove-file'.
File: pcl-cvs.info, Node: Undoing changes, Next: Removing handled entries, Prev: Adding and removing files, Up: Commands
Undoing changes
===============
`U'
If you have modified a file, and for some reason decide that you
don't want to keep the changes, you can undo them with this
command. It works by removing your working copy of the file and
then getting the latest version from the repository
(`cvs-mode-undo-local-changes'.
File: pcl-cvs.info, Node: Removing handled entries, Next: Ignoring files, Prev: Undoing changes, Up: Commands
Removing handled entries
========================
`x'
This command allows you to remove all entries that you have
processed. More specifically, the lines for `Updated' files
(*note File status::. and files that have been checked in (*note
Committing changes::.) are removed from the buffer. If a
directory becomes empty the heading for that directory is also
removed. This makes it easier to get an overview of what needs to
be done.
The command is called `cvs-mode-remove-handled'. If
`cvs-auto-remove-handled' is set to non-`nil' this will
automatically be performed after every commit.
`C-k'
This command can be used for lines that `cvs-mode-remove-handled'
would not delete, but that you want to delete
(`cvs-mode-acknowledge').
File: pcl-cvs.info, Node: Ignoring files, Next: Viewing differences, Prev: Removing handled entries, Up: Commands
Ignoring files
==============
`i'
Arrange so that CVS will ignore the selected files. The file
names are added to the `.cvsignore' file in the corresponding
directory. If the `.cvsignore' doesn't exist it will be created.
The `.cvsignore' file should normally be added to the repository,
but you could ignore it also if you like it better that way.
This runs `cvs-mode-ignore'.
File: pcl-cvs.info, Node: Viewing differences, Next: Invoking Ediff, Prev: Ignoring files, Up: Commands
Viewing differences
===================
`d'
Display a `cvs diff' between the selected files and the RCS version
that they are based on. *Note Customization:: describes how you
can send flags to `cvs diff'. If CVS-DIFF-IGNORE-MARKS is set to a
non-`nil' value or if a prefix argument is given (but not both) any
marked files will not be considered to be selected.
(`cvs-mode-diff-cvs').
`b'
If CVS finds a conflict while merging two versions of a file
(during a `cvs update', *note Updating the directory::.) it will
save the original file in a file called `.#FILE.VERSION' where
FILE is the name of the file, and VERSION is the RCS version
number that your file was based on.
With the `b' command you can run a `diff' on the files
`.#FILE.VERSION' and `FILE'. You can get a context- or Unidiff by
setting `cvs-diff-flags' - *note Customization::.. This command
only works on files that have status `Conflict' or `Merged'.
If CVS-DIFF-IGNORE-MARKS is set to a non-`nil' value or if a
prefix argument is given (but not both) any marked files will not
be considered to be selected. (`cvs-mode-diff-backup').
File: pcl-cvs.info, Node: Invoking Ediff, Next: Invoking Emerge, Prev: Viewing differences, Up: Commands
Running ediff
=============
`e'
This command works slightly different depending on the version of
`ediff' and the file status.
With modern versions of `ediff', this command invokes
`run-ediff-from-cvs-buffer' on one file.
*Note:* When the file status is `Merged' or `Conflict', CVS has
already performed a merge. The resulting file is not used in any
way if you use this command. If you use the `q' command inside
`ediff' (to successfully terminate a merge) the file that CVS
created will be overwritten.
Older versions of `ediff' use an interface similar to `emerge'.
The function `cvs-old-ediff-interface' is invoked if the version
of `ediff' you have doesn't support `run-ediff-from-cvs-buffer'.
These older versions do not support merging of revisions.
`Modified'
Run `ediff-files' with your working file as file A, and the
latest revision in the repository as file B.
`Merged'
`Conflict'
Run `ediff-files3' with your working file (as it was prior to
your invocation of `cvs-update') as file A, the latest
revision in the repository as file B, and the revision that
you based your local modifications on as ancestor.
`Updated'
`Patched'
Run `ediff-files' with your working file as file A, and a
given revision in the repository as file B. You are prompted
for the revision to ediff against, and you may specify either
a tag name or a numerical revision number (*note Getting info
about files::.).
File: pcl-cvs.info, Node: Invoking Emerge, Next: Reverting your buffers, Prev: Invoking Ediff, Up: Commands
Running emerge
==============
`E'
Invoke `emerge' on one file. This command works slightly different
depending on the file status.
`Modified'
Run `emerge-files' with your working file as file A, and the
latest revision in the repository as file B.
`Merged'
`Conflict'
Run `emerge-files-with-ancestor' with your working file (as
it was prior to your invocation of `cvs-update') as file A,
the latest revision in the repository as file B, and the
revision that you based your local modifications on as
ancestor.
*Note:* When the file status is `Merged' or `Conflict', CVS has
already performed a merge. The resulting file is not used in any
way if you use this command. If you use the `q' command inside
`emerge' (to successfully terminate the merge) the file that CVS
created will be overwritten.
File: pcl-cvs.info, Node: Reverting your buffers, Next: Miscellaneous commands, Prev: Invoking Emerge, Up: Commands
Reverting your buffers
======================
`R'
If you are editing (or just viewing) a file in a buffer, and that
file is changed by CVS during a `cvs-update', all you have to do
is type `R' in the *cvs* buffer to read in the new versions of the
files.
All files that are `Updated', `Merged' or in `Conflict' are
reverted from the disk. Any other files are ignored. Only files
that you were already editing are read.
An error is signalled if you have modified the buffer since it was
last changed. (`cvs-mode-revert-updated-buffers').
File: pcl-cvs.info, Node: Miscellaneous commands, Prev: Reverting your buffers, Up: Commands
Miscellaneous commands
======================
`M-x cvs-byte-compile-files'
Byte compile all selected files that end in .el.
`M-x cvs-delete-lock'
This command can be used in any buffer, and deletes the lock files
that the *cvs* buffer informs you about. You should normally
never have to use this command since CVS tries very carefully to
always remove the lock files itself.
You can only use this command when a message in the *cvs* buffer
tells you so. You should wait a while before using this command
in case someone else is running a cvs command.
`q'
Bury the *cvs* buffer. (`bury-buffer').
File: pcl-cvs.info, Node: Customization, Next: Future enhancements, Prev: Commands, Up: Top
Customization
*************
If you have an idea about any customization that would be handy but
isn't present in this list, please tell me! *Note Bugs:: for info on
how to reach me.
`cvs-erase-input-buffer'
If set to anything else than `nil' the edit buffer will be erased
before you write the log message (*note Committing changes::.).
`cvs-inhibit-copyright-message'
The copyright message that is displayed on startup can be annoying
after a while. Set this variable to `t' if you want to get rid of
it. (But don't set this to `t' in the system defaults file - new
users should see this message at least once).
`cvs-diff-flags'
A list of strings to pass as arguments to the `cvs diff' and
`diff' programs. This is used by `cvs-mode-diff-cvs' and
`cvs-mode-diff-backup' (key `b', *note Viewing differences::.). If
you prefer the Unidiff format you could add this line to your
`.emacs' file:
(setq cvs-diff-flags '("-u"))
`cvs-diff-ignore-marks'
If this variable is non-`nil' or if a prefix argument is given (but
not both) to `cvs-mode-diff-cvs' or `cvs-mode-diff-backup' marked
files are not considered selected.
`cvs-log-flags'
List of strings to send to `cvs log'. Used by `cvs-mode-log' (key
`l', *note Getting info about files::.).
`cvs-status-flags'
List of strings to send to `cvs status'. Used by `cvs-mode-status'
(key `s', *note Getting info about files::.).
`cvs-auto-remove-handled'
If this variable is set to any non-`nil' value
`cvs-mode-remove-handled' will be called every time you check in
files, after the check-in is ready. *Note Removing handled
entries::.
`cvs-auto-revert-after-commit'
If this variable is set to any non-`nil' value any buffers you have
that visit a file that is committed will be automatically reverted.
This variable is default `t'. *Note Committing changes::.
`cvs-update-prog-output-skip-regexp'
The `-u' flag in the `modules' file can be used to run a command
whenever a `cvs update' is performed (see cvs(5)). This regexp is
used to search for the last line in that output. It is normally
set to `"$"'. That setting is only correct if the command outputs
nothing. Note that pcl-cvs will get very confused if the command
outputs *anything* to `stderr'.
`cvs-cvsroot'
This variable can be set to override `CVSROOT'. It should be a
string. If it is set then everytime a cvs command is run it will
be called as `cvs -d CVS-CVSROOT...' This can be useful if your
site has several repositories.
`TMPDIR'
Pcl-cvs uses this *environment variable* to decide where to put the
temporary files it needs. It defaults to `/tmp' if it is not set.
`cvs-commit-buffer-require-final-newline'
When you enter a log message in the `*cvs-commit-message*' buffer
pcl-cvs will normally automatically insert a trailing newline,
unless there already is one. This behavior can be controlled via
`cvs-commit-buffer-require-final-newline'. If it is `t' (the
default behavior), a newline will always be appended. If it is
`nil', newlines will never be appended. Any other value causes
pcl-cvs to ask the user whenever there is no trailing newline in
the commit message buffer.
`cvs-sort-ignore-file'
If this variable is set to any non-`nil' value the `.cvsignore'
will always be sorted whenever you use `cvs-mode-ignore' to add a
file to it. This option is on by default.
File: pcl-cvs.info, Node: Future enhancements, Next: Bugs, Prev: Customization, Up: Top
Future enhancements
*******************
Pcl-cvs is still under development and needs a number of
enhancements to be called complete. Below is my current wish-list for
future releases of pcl-cvs. Please, let me know which of these
features you want most. They are listed below in approximately the
order that I currently think I will implement them in.
* Rewritten parser code. There are many situations where pcl-cvs
will fail to recognize the output from CVS. The situation could
be greatly increased.
* `cvs-status'. This will run `cvs status' in a directory and
produce a buffer that looks pretty much like the current *cvs*
buffer. That buffer will include information for all
version-controlled files. (There will be a simple keystroke to
remove all "uninteresting" files, that is, files that are
"Up-to-date"). In this new buffer you will be able to update a
file, commit a file, et c. The big win with this is that you will
be able to watch the differences between your current working file
and the head revision in the repository before you update the
file, and you can then choose to update it or let it wait for a
while longer.
* Log mode. When this mode is finished you will be able to move
around (using `n' and `p') between the revisions of a file, mark
two of them, and run a diff between them. You will be able to
hide branches (similar to the way you can hide sub-paragraphs in
outline-mode) and do merges between revisions. Other ideas about
this are welcome.
* The current model for marks in the *cvs* buffer seems to be
confusing. I am considering to use the VM model instead, where
marks are normally inactive. To activate the mark, you issue a
command like `cvs-mode-next-command-uses-marks'. I might
implement a flag so that you can use either version. Feedback on
this before I start coding it is very welcome.
* It should be possible to run commands such as `cvs log', `cvs
status' and `cvs commit' directly from a buffer containing a file,
instead of having to `cvs-update'. If the directory contains many
files the `cvs-update' can take quite some time, especially on a
slow machine. I planed to put these kind of commands on the prefix
`C-c C-v', but that turned out to be used by for instance c++-mode.
If you have any suggestions for a better prefix key, please let me
know.
* Increased robustness. For instance, you can not currently press
`C-g' when you are entering the description of a file that you are
adding without confusing pcl-cvs.
* Support for multiple active *cvs* buffers.
* Dired support. I have an experimental `dired-cvs.el' that works
together with CVS 1.2. Unfortunately I wrote it on top of a
non-standard `dired.el', so it must be rewritten.
* An ability to send user-supplied options to all the cvs commands.
* Pcl-cvs is not at all clever about what it should do when `cvs
update' runs a program (due to the `-u' option in the `modules'
file -- see `cvs(5)'). The current release uses a regexp to
search for the end. At the very least that regexp should be
configured for different modules. Tell me if you have any idea
about what is the right thing to do. In a perfect world the
program should also be allowed to print to `stderr' without
causing pcl-cvs to crash.
If you miss something in this wish-list, let me know! I don't
promise that I will write it, but I will at least try to coordinate the
efforts of making a good Emacs front end to CVS. See *Note Bugs:: for
information about how to reach me.
So far, I have written most of pcl-cvs in my all-to-rare spare time.
If you want pcl-cvs to be developed faster you can write a contract
with Signum Support to do the extension. You can reach Signum Support
by email to `info@signum.se' or via mail to Signum Support AB, Box
2044, S-580 02 Linkoping, Sweden. Phone: +46 (0) 13 - 21 46 00. Fax:
+46 (0) 13 - 21 47 00.
File: pcl-cvs.info, Node: Bugs, Next: COPYING, Prev: Future enhancements, Up: Top
Bugs (known and unknown)
************************
If you find a bug or misfeature, don't hesitate to tell me! Send
email to `ceder@lysator.liu.se'.
If you have ideas for improvements, or if you have written some
extensions to this package, I would like to hear from you. I hope that
you find this package useful!
Below is a partial list of currently known problems with pcl-cvs
version 1.05.
Commit causes Emacs to hang
Emacs waits for the `cvs commit' command to finish before you can
do anything. If you start a background job from the loginfo file
you must take care that it closes `stdout' and `stderr' if you do
not want to wait for it. (You do that with `background-command &>-
2&>- &' if you are starting `background-command' from a `/bin/sh'
shell script).
Your emacs will also hang if there was a lock file in the
repository. In this case you can type `C-g' to get control over
your emacs again.
Name clash in Emacs 19
This is really a bug in Elib or the Emacs 19 distribution. Both
Elib and Emacs 19.6 through at least 19.10 contains a file named
`cookie.el'. One of the files will have to be renamed, and we are
currently negotiating about which of the files to rename.
Commands while cvs-update is running
It is possible to type commands in the *cvs* buffer while the
update is running, but error messages is all that you will get.
The error messages should be better.
Unexpected output from CVS
Unexpected output from CVS confuses pcl-cvs. It will currently
create a bug report that you can mail to me. It should do
something more civilized.
File: pcl-cvs.info, Node: COPYING, Next: Function and Variable Index, Prev: Bugs, Up: Top
GNU GENERAL PUBLIC LICENSE
**************************
File: pcl-cvs.info, Node: Function and Variable Index, Next: Concept Index, Prev: COPYING, Up: Top
Function and Variable Index
***************************
* Menu:
* bury-buffer: Miscellaneous commands.
* cookie-next-cookie: Movement commands.
* cookie-previous-cookie: Movement commands.
* cvs-auto-remove-handled (variable): Customization.
* cvs-auto-revert-after-commit (variable) <1>: Customization.
* cvs-auto-revert-after-commit (variable): Committing changes.
* cvs-byte-compile-files: Miscellaneous commands.
* cvs-commit-buffer-require-final-newline (variable): Customization.
* cvs-cvsroot (variable): Customization.
* cvs-delete-lock: Updating the directory.
* cvs-diff-flags (variable): Customization.
* cvs-diff-ignore-marks (variable) <1>: Customization.
* cvs-diff-ignore-marks (variable): Viewing differences.
* cvs-erase-input-buffer (variable) <1>: Customization.
* cvs-erase-input-buffer (variable): Committing changes.
* cvs-inhibit-copyright-message (variable): Customization.
* cvs-log-flags (variable): Customization.
* cvs-mode-acknowledge: Removing handled entries.
* cvs-mode-add: Adding and removing files.
* cvs-mode-add-change-log-entry-other-window: Editing files.
* cvs-mode-changelog-commit: Committing changes.
* cvs-mode-commit: Committing changes.
* cvs-mode-diff-backup: Viewing differences.
* cvs-mode-diff-cvs: Viewing differences.
* cvs-mode-ediff: Invoking Ediff.
* cvs-mode-emerge: Invoking Emerge.
* cvs-mode-find-file: Editing files.
* cvs-mode-find-file-other-window: Editing files.
* cvs-mode-ignore: Ignoring files.
* cvs-mode-log: Getting info about files.
* cvs-mode-mark: Marking files.
* cvs-mode-mark-all-files: Marking files.
* cvs-mode-remove-file: Adding and removing files.
* cvs-mode-remove-handled: Removing handled entries.
* cvs-mode-revert-updated-buffers: Reverting your buffers.
* cvs-mode-status: Getting info about files.
* cvs-mode-undo-local-changes: Undoing changes.
* cvs-mode-unmark: Marking files.
* cvs-mode-unmark-all-files: Marking files.
* cvs-mode-unmark-up: Marking files.
* cvs-mode-update-no-prompt: Updating the directory.
* cvs-old-ediff-interface: Invoking Ediff.
* cvs-sort-ignore-file (variable): Customization.
* cvs-status-flags (variable): Customization.
* cvs-update: Updating the directory.
* cvs-update-prog-output-skip-regexp (variable): Customization.
* run-ediff-from-cvs-buffer: Invoking Ediff.
* TMPDIR (environment variable): Customization.
File: pcl-cvs.info, Node: Concept Index, Next: Key Index, Prev: Function and Variable Index, Up: Top
Concept Index
*************
* Menu:
* -u option in modules file: Customization.
* .cvsignore file, sorting: Customization.
* About pcl-cvs: About pcl-cvs.
* Active files: Selected files.
* Added (file status): File status.
* Adding files: Adding and removing files.
* Archives: Archives.
* Author, how to reach: Bugs.
* Authors: Contributors.
* Automatically inserting newline: Customization.
* Automatically remove handled files: Customization.
* Automatically sorting .cvsignore: Customization.
* Buffer contents: Buffer contents.
* Bugs, how to report them: Bugs.
* Bugs, known: Bugs.
* Byte compilation: Miscellaneous commands.
* Ci: Committing changes.
* Commit buffer: Committing changes.
* Commit message, inserting newline: Customization.
* Committing changes: Committing changes.
* Conflict (file status): File status.
* Conflicts, how to resolve them: Viewing differences.
* Conflicts, resolving <1>: Invoking Emerge.
* Conflicts, resolving: Invoking Ediff.
* Context diff, how to get: Customization.
* Contributors: Contributors.
* Copyright message, getting rid of it: Customization.
* Customization: Customization.
* Deleting files: Adding and removing files.
* Diff: Viewing differences.
* Dired: Editing files.
* Ediff <1>: Invoking Emerge.
* Ediff <2>: Invoking Ediff.
* Ediff: Viewing differences.
* Edit buffer: Committing changes.
* Editing files: Editing files.
* Email archives: Archives.
* Email to the author: Bugs.
* Emerge: Invoking Emerge.
* Enhancements: Future enhancements.
* Erasing commit message: Committing changes.
* Erasing the input buffer: Customization.
* Example run: Getting started.
* Expunging uninteresting entries: Removing handled entries.
* FAQ: Bugs.
* File selection: Selected files.
* File status: File status.
* Finding files: Editing files.
* Flush changes: Undoing changes.
* Ftp-sites: Archives.
* Generating a typeset manual: Typeset manual installation.
* Generating the on-line manual: On-line manual installation.
* Getting pcl-cvs: Archives.
* Getting rid of lock files: Miscellaneous commands.
* Getting rid of the Copyright message.: Customization.
* Getting rid of uninteresting lines: Removing handled entries.
* Getting status: Getting info about files.
* Getting the *cvs* buffer: Updating the directory.
* Handled lines, removing them: Removing handled entries.
* Info-file (how to generate): On-line manual installation.
* Inhibiting the Copyright message.: Customization.
* Installation: Installation.
* Installation of elisp files: Pcl-cvs installation.
* Installation of on-line manual: On-line manual installation.
* Installation of typeset manual: Typeset manual installation.
* Introduction: Getting started.
* Invoking dired: Editing files.
* Invoking ediff <1>: Invoking Ediff.
* Invoking ediff: Viewing differences.
* Invoking emerge: Invoking Emerge.
* Known bugs: Bugs.
* Loading files: Editing files.
* Lock files: Miscellaneous commands.
* Log (RCS/cvs command): Getting info about files.
* Manual installation (on-line): On-line manual installation.
* Manual installation (typeset): Typeset manual installation.
* Marked files: Selected files.
* Marking files: Marking files.
* Merged (file status): File status.
* Modified (file status): File status.
* Modules file (-u option): Customization.
* Move away FILE - it is in the way (file status): File status.
* Movement Commands: Movement commands.
* On-line manual (how to generate): On-line manual installation.
* Patched (file status): File status.
* Printing a manual: Typeset manual installation.
* Problems, list of common: Bugs.
* Putting files under CVS control: Adding and removing files.
* Recompiling elisp files: Miscellaneous commands.
* Removed (file status): File status.
* Removed by you, changed in repository (file status): File status.
* Removed from repository (file status): File status.
* Removed from repository, changed by you (file status): File status.
* Removing files: Adding and removing files.
* Removing uninteresting (processed) lines: Removing handled entries.
* Reporting bugs and ideas: Bugs.
* Require final newline: Customization.
* Resolving conflicts <1>: Invoking Emerge.
* Resolving conflicts: Invoking Ediff.
* Resurrecting files: Adding and removing files.
* Reverting buffers: Reverting your buffers.
* Reverting buffers after commit <1>: Customization.
* Reverting buffers after commit: Committing changes.
* Selected files: Selected files.
* Selecting files (commands to mark files): Marking files.
* Sites: Archives.
* Sorting the .cvsignore file: Customization.
* Status (cvs command): Getting info about files.
* Syncing buffers: Reverting your buffers.
* TeX - generating a typeset manual: Typeset manual installation.
* This repository is missing!... (file status): File status.
* Undo changes: Undoing changes.
* Unidiff, how to get: Customization.
* Uninteresting entries, getting rid of them: Removing handled entries.
* Unknown (file status): File status.
* Update program (-u option in modules file): Customization.
* Updated (file status): File status.
* Variables, list of all: Customization.
* Viewing differences <1>: Invoking Emerge.
* Viewing differences <2>: Invoking Ediff.
* Viewing differences: Viewing differences.
File: pcl-cvs.info, Node: Key Index, Prev: Concept Index, Up: Top
Key Index
*********
* Menu:
* a - add a file: Adding and removing files.
* A - add ChangeLog entry: Editing files.
* b - diff backup file: Viewing differences.
* c - commit files: Committing changes.
* C - commit files with ChangeLog message: Committing changes.
* C-k - remove selected entries: Removing handled entries.
* C-n - Move down one file: Movement commands.
* C-p - Move up one file: Movement commands.
* d - run cvs diff: Viewing differences.
* DEL - unmark previous file: Marking files.
* e - invoke ediff: Invoking Ediff.
* E - invoke emerge: Invoking Emerge.
* ESC DEL - unmark all files: Marking files.
* f - find file or directory: Editing files.
* g - Rerun cvs update: Updating the directory.
* i - ignoring files: Ignoring files.
* l - run cvs log: Getting info about files.
* m - marking a file: Marking files.
* M - marking all files: Marking files.
* n - Move down one file: Movement commands.
* o - find file in other window: Editing files.
* p - Move up on file: Movement commands.
* q - bury the *cvs* buffer: Miscellaneous commands.
* r - remove a file: Adding and removing files.
* R - revert buffers: Reverting your buffers.
* s - run cvs status: Getting info about files.
* SPC - Move down one file: Movement commands.
* U - undo changes: Undoing changes.
* u - unmark a file: Marking files.
* x - remove processed entries: Removing handled entries.
Tag Table:
Node: Top1024
Node: Installation3786
Node: Pcl-cvs installation4577
Node: On-line manual installation7055
Node: Typeset manual installation7983
Node: About pcl-cvs8727
Node: Contributors9173
Node: Archives11106
Node: Getting started11751
Node: Buffer contents14201
Node: File status14755
Node: Selected files18148
Node: Commands18821
Node: Updating the directory20165
Node: Movement commands21949
Node: Marking files22540
Node: Committing changes23408
Node: Editing files25821
Node: Getting info about files26672
Node: Adding and removing files27157
Node: Undoing changes28513
Node: Removing handled entries28978
Node: Ignoring files29902
Node: Viewing differences30437
Node: Invoking Ediff31753
Node: Invoking Emerge33473
Node: Reverting your buffers34510
Node: Miscellaneous commands35222
Node: Customization35970
Node: Future enhancements39648
Node: Bugs43851
Node: COPYING45617
Node: Function and Variable Index45769
Node: Concept Index48843
Node: Key Index56160
End Tag Table